View Javadoc

1   /*
2    * Copyright 2006 Eric Ballet Baz
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.maven.author.resolver;
18  
19  import java.io.File;
20  
21  /**
22   * AuthorResolver based on SCM.
23   * This resolver uses SCM to resolve the author(s).
24   *
25   * @todo Not yet implemented.
26   *
27   * @author Eric Ballet Baz
28   */
29  public class SCMAuthorResolver implements AuthorResolver {
30  
31      /**
32       * @see org.apache.maven.author.resolver.AuthorResolver#resolveAuthors(java.io.File)
33       * @todo Not yet implemented.
34       */
35      public final String[] resolveAuthors(final File file) {
36          // Check argument
37          if (file == null) {
38              throw new IllegalArgumentException("Argument [file] should not be null");
39          }
40          if (file.isDirectory()) {
41              throw new IllegalArgumentException("Argument [file] should not be a directory");
42          }
43  
44          // @todo: to implement
45  
46          // No author has been found
47          return new String[0];
48      }
49  }